﻿#pragma warning disable IDE1006
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace WUDI.ECharts.Aria
{
	/// <summary>
	/// W3C 制定了无障碍富互联网应用规范集（WAI-ARIA
	/// <para>
	/// <see href="https://www.w3.org/WAI/intro/aria"/>，the Accessible Rich Internet Applications Suite），致力于使得网页内容和网页应用能够被更多残障人士访问
	/// </para>
	/// <para>
	/// ECharts 4.0 遵从这一规范，支持自动根据图表配置项智能生成描述，使得盲人可以在朗读设备的帮助下了解图表内容，让图表可以被更多人群访问
	/// </para>
	/// <para>
	/// 默认关闭，需要通过将 aria.show
	/// </para>
	/// <para>
	/// #aria.show 设置为 true 开启
	/// </para>
	/// <para>
	/// 开启后，会根据图表、数据、标题等情况，自动智能生成关于图表的描述，用户也可以通过配置项修改描述
	/// </para>
	/// </summary>
	public class Aria
	{

		/// <summary>
		/// 是否开启无障碍访问。开启后将生成 aria-label 属性。
		/// </summary>
		public dynamic show { get; set; }  = false;

		/// <summary>
		/// 默认采用算法自动生成图表描述，如果用户需要完全自定义，可以将这个值设为描述
		/// <para>
		/// 如将其设置为 这是一个展示了价格走势的图表，则 aria-label 属性的值即为该字符串
		/// </para>
		/// <para>
		/// 这一配置项常用于展示单个的数据并不能展示图表内容时，用户显示指定概括性描述图表的文字
		/// </para>
		/// <para>
		/// 例如图表是一个包含大量散点图的地图，默认的算法只能显示数据点的位置，不能从整体上传达作者的意图
		/// </para>
		/// <para>
		/// 这时候，可以将 description 指定为作者想表达的内容即可
		/// </para>
		/// </summary>
		public dynamic description { get; set; } 

		/// <summary>
		/// 对于图表的整体性描述。
		/// </summary>
		public WUDI.ECharts.Aria.General general { get; set; } 

		/// <summary>
		/// 系列相关的配置项。
		/// </summary>
		public WUDI.ECharts.Aria.Series.Series series { get; set; } 

		/// <summary>
		/// 数据相关的配置项。
		/// </summary>
		public WUDI.ECharts.Aria.Data.Data data { get; set; } 

	}
}